Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix meta tags #162

Merged
merged 2 commits into from
Jan 27, 2025
Merged

Fix meta tags #162

merged 2 commits into from
Jan 27, 2025

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 27, 2025

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

This PR updates descriptions and keywords across various model comparison pages in the Ultralytics documentation, ensuring clarity, relevance, and improved discoverability.

📊 Key Changes

  • Descriptions: Enhanced to provide clearer explanations of the purpose and content for each comparison page, focusing on architecture, performance, and use cases.
  • Keywords: Updated to include more specific terms like "real-time detection", "transformers", and "model performance", offering better alignment with user search terms.
  • Consistency: Streamlined descriptions to follow a uniform tone and format across all comparison pages.

🎯 Purpose & Impact

  • 🧐 Improved Clarity: Users can quickly understand what each page offers, helping them select the best model for their needs.
  • 🔍 Better Searchability: Enhanced keywords make it easier for users to discover relevant content through search engines and within the documentation.
  • 📚 Cohesive Experience: Ensures a standard tone and structure across multiple comparison pages, making navigation and content comprehension more seamless.

Copy link

vercel bot commented Jan 27, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 27, 2025 0:57am

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 27, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting an ultralytics/docs 🚀 PR! To ensure a seamless integration of your contributions, please review the following checklist:

  • Define a Purpose: Clearly state the purpose of your changes in this PR. Link any relevant issues or discussions to provide context. Ensure your commit messages are clear and follow our conventions.
  • Synchronize with Source: Verify that your PR is aligned with the latest main branch of the ultralytics/docs repository. Merge any updates if required by clicking the 'Update Branch' button here or executing git pull origin main locally.
  • Pass CI Checks: Confirm that all required Continuous Integration (CI) checks have passed. For any failing checks, please investigate and resolve the issues.
  • Enhance Documentation: Ensure changes contribute to the Ultralytics Docs with improvements or additions that match the scope of this PR.
  • Add or Update Tests: Where applicable, verify that existing tests cover your changes or introduce new tests. Confirm all tests pass successfully.
  • Sign the CLA: If this is your initial PR to Ultralytics, sign our Contributor License Agreement (CLA) by stating, “I have read the CLA Document and I hereby sign the CLA” in a new comment under this PR.
  • Minimize Changes: Ensure that changes are scoped specifically to this update. Avoid unrelated modifications to maintain PR focus. “Perfection is achieved, not when there’s nothing more to add, but when there’s nothing left to take away.” — Antoine de Saint-Exupéry

📢 Quick Reminders:

  • For documentation-related updates, check whether the changes align with the Ultralytics style guide for consistency.
  • If you're addressing a bug, and additional testing or an explanation is needed, please provide a Minimum Reproducible Example (MRE) to illustrate the issue or resolution.

For further instructions and guidance, visit our Contributing Guide.

This is an automated response 🤖 to streamline contributions, but rest assured that an Ultralytics team member will review this PR promptly. If you have any questions or need assistance, feel free to comment here. Thank you for helping improve Ultralytics! 🌟🚀

@glenn-jocher glenn-jocher merged commit be12aaf into main Jan 27, 2025
4 checks passed
@glenn-jocher glenn-jocher deleted the update-meta branch January 27, 2025 00:58
@UltralyticsAssistant
Copy link
Member

🎉 Your PR has been merged, @glenn-jocher – thank you for your thoughtful contributions! 🛠️

Your detailed enhancements to descriptions and keywords in the documentation bring greater clarity and utility to the community, empowering users to make better decisions with ease. By improving discoverability and consistency, you've made an immediate and lasting impact.

As Marcus Aurelius once said, "The impediment to action advances action. What stands in the way becomes the way." Your work here removes barriers, paving a smoother path for knowledge and innovation to flow. 🚀

Keep shining and making a difference one PR at a time! ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants